<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>mbox: XMbox_Config Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">mbox
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_mbox___config.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XMbox_Config Struct Reference<div class="ingroups"><a class="el" href="group__mbox.html">Overview</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>This typedef contains configuration information for the device.  
 <a href="struct_x_mbox___config.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a8c1ef8d0a7976f0d4b358f8afbf7f48b"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#a8c1ef8d0a7976f0d4b358f8afbf7f48b">DeviceId</a></td></tr>
<tr class="memdesc:a8c1ef8d0a7976f0d4b358f8afbf7f48b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique ID of device.  <a href="#a8c1ef8d0a7976f0d4b358f8afbf7f48b">More...</a><br/></td></tr>
<tr class="separator:a8c1ef8d0a7976f0d4b358f8afbf7f48b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a357a3188be88d9aaba7e8cc60960a8"><td class="memItemLeft" align="right" valign="top">UINTPTR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#a7a357a3188be88d9aaba7e8cc60960a8">BaseAddress</a></td></tr>
<tr class="memdesc:a7a357a3188be88d9aaba7e8cc60960a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register base address.  <a href="#a7a357a3188be88d9aaba7e8cc60960a8">More...</a><br/></td></tr>
<tr class="separator:a7a357a3188be88d9aaba7e8cc60960a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae59a7f14795bc768c36b105863e2efc8"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#ae59a7f14795bc768c36b105863e2efc8">UseFSL</a></td></tr>
<tr class="memdesc:ae59a7f14795bc768c36b105863e2efc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">use the FSL for the interface.  <a href="#ae59a7f14795bc768c36b105863e2efc8">More...</a><br/></td></tr>
<tr class="separator:ae59a7f14795bc768c36b105863e2efc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e08e69be2c504f49b76b7b992701e5f"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#a9e08e69be2c504f49b76b7b992701e5f">SendID</a></td></tr>
<tr class="memdesc:a9e08e69be2c504f49b76b7b992701e5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">FSL link for the write i/f mailbox.  <a href="#a9e08e69be2c504f49b76b7b992701e5f">More...</a><br/></td></tr>
<tr class="separator:a9e08e69be2c504f49b76b7b992701e5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a609445dac27b19ef129dd295fc252453"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#a609445dac27b19ef129dd295fc252453">RecvID</a></td></tr>
<tr class="memdesc:a609445dac27b19ef129dd295fc252453"><td class="mdescLeft">&#160;</td><td class="mdescRight">FSL link for the read i/f mailbox.  <a href="#a609445dac27b19ef129dd295fc252453">More...</a><br/></td></tr>
<tr class="separator:a609445dac27b19ef129dd295fc252453"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This typedef contains configuration information for the device. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a7a357a3188be88d9aaba7e8cc60960a8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UINTPTR XMbox_Config::BaseAddress</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Register base address. </p>

<p>Referenced by <a class="el" href="xmbox__intr__example_8c.html#adf6c143c65ce968f72fc282ec63280e8">MailboxExample()</a>, <a class="el" href="xmbox__example_8c.html#a29bcf620083d6150359747d6ffcb5562">ProdCon()</a>, <a class="el" href="group__mbox.html#ga34fbeaf8de9092cb4d5b00dfbf054426">XMbox_CfgInitialize()</a>, <a class="el" href="group__mbox.html#gab93a50b0032e4b6202c23c4201e0591e">XMbox_ClearInterrupt()</a>, <a class="el" href="group__mbox.html#ga10691489238a2a1b8515468b416d773e">XMbox_Flush()</a>, <a class="el" href="group__mbox.html#gacb96b1964aa476b4d60df4fd2440022c">XMbox_GetInterruptEnable()</a>, <a class="el" href="group__mbox.html#gaf73757d06d4cc60466e563ab185a6c07">XMbox_GetInterruptStatus()</a>, <a class="el" href="group__mbox.html#ga8620711a04da0032b216e3f57a80570d">XMbox_GetStatus()</a>, <a class="el" href="group__mbox.html#gabb01fe466ffcd0da315ffee115f4cd60">XMbox_IsEmpty()</a>, <a class="el" href="group__mbox.html#gaa9db05bc2935bcc2230ff023b5c9cbcc">XMbox_IsFull()</a>, <a class="el" href="group__mbox.html#gaa1f68405027d147c68aa53bcb49fbd5a">XMbox_Read()</a>, <a class="el" href="group__mbox.html#gab14511b623c1d3c191cdc441b8909006">XMbox_ReadBlocking()</a>, <a class="el" href="group__mbox.html#gacf8d6e720149452270eac0493537a233">XMbox_ResetFifos()</a>, <a class="el" href="group__mbox.html#ga8e56860ea2cf7f4f1df0f1862d8c4c61">XMbox_SetInterruptEnable()</a>, <a class="el" href="group__mbox.html#ga8c05b007d0f92ca32702db58573302a9">XMbox_SetReceiveThreshold()</a>, <a class="el" href="group__mbox.html#ga4fb918498d8adc676f4ea554585609d2">XMbox_SetSendThreshold()</a>, <a class="el" href="group__mbox.html#ga254c4e5a042e34520c3669fbf9651bc2">XMbox_Write()</a>, and <a class="el" href="group__mbox.html#ga23ee00f97807790770f2dab9b2ea3b0e">XMbox_WriteBlocking()</a>.</p>

</div>
</div>
<a class="anchor" id="a8c1ef8d0a7976f0d4b358f8afbf7f48b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XMbox_Config::DeviceId</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unique ID of device. </p>

</div>
</div>
<a class="anchor" id="a609445dac27b19ef129dd295fc252453"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XMbox_Config::RecvID</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>FSL link for the read i/f mailbox. </p>

<p>Referenced by <a class="el" href="group__mbox.html#ga10691489238a2a1b8515468b416d773e">XMbox_Flush()</a>, <a class="el" href="group__mbox.html#gabb01fe466ffcd0da315ffee115f4cd60">XMbox_IsEmpty()</a>, <a class="el" href="group__mbox.html#gaa1f68405027d147c68aa53bcb49fbd5a">XMbox_Read()</a>, and <a class="el" href="group__mbox.html#gab14511b623c1d3c191cdc441b8909006">XMbox_ReadBlocking()</a>.</p>

</div>
</div>
<a class="anchor" id="a9e08e69be2c504f49b76b7b992701e5f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XMbox_Config::SendID</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>FSL link for the write i/f mailbox. </p>

<p>Referenced by <a class="el" href="group__mbox.html#gaa9db05bc2935bcc2230ff023b5c9cbcc">XMbox_IsFull()</a>, <a class="el" href="group__mbox.html#ga254c4e5a042e34520c3669fbf9651bc2">XMbox_Write()</a>, and <a class="el" href="group__mbox.html#ga23ee00f97807790770f2dab9b2ea3b0e">XMbox_WriteBlocking()</a>.</p>

</div>
</div>
<a class="anchor" id="ae59a7f14795bc768c36b105863e2efc8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XMbox_Config::UseFSL</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>use the FSL for the interface. </p>

<p>Referenced by <a class="el" href="xmbox__intr__example_8c.html#adf6c143c65ce968f72fc282ec63280e8">MailboxExample()</a>, <a class="el" href="group__mbox.html#gab93a50b0032e4b6202c23c4201e0591e">XMbox_ClearInterrupt()</a>, <a class="el" href="group__mbox.html#ga10691489238a2a1b8515468b416d773e">XMbox_Flush()</a>, <a class="el" href="group__mbox.html#gacb96b1964aa476b4d60df4fd2440022c">XMbox_GetInterruptEnable()</a>, <a class="el" href="group__mbox.html#gaf73757d06d4cc60466e563ab185a6c07">XMbox_GetInterruptStatus()</a>, <a class="el" href="group__mbox.html#ga8620711a04da0032b216e3f57a80570d">XMbox_GetStatus()</a>, <a class="el" href="group__mbox.html#gabb01fe466ffcd0da315ffee115f4cd60">XMbox_IsEmpty()</a>, <a class="el" href="group__mbox.html#gaa9db05bc2935bcc2230ff023b5c9cbcc">XMbox_IsFull()</a>, <a class="el" href="group__mbox.html#gaa1f68405027d147c68aa53bcb49fbd5a">XMbox_Read()</a>, <a class="el" href="group__mbox.html#gab14511b623c1d3c191cdc441b8909006">XMbox_ReadBlocking()</a>, <a class="el" href="group__mbox.html#gacf8d6e720149452270eac0493537a233">XMbox_ResetFifos()</a>, <a class="el" href="group__mbox.html#ga8e56860ea2cf7f4f1df0f1862d8c4c61">XMbox_SetInterruptEnable()</a>, <a class="el" href="group__mbox.html#ga8c05b007d0f92ca32702db58573302a9">XMbox_SetReceiveThreshold()</a>, <a class="el" href="group__mbox.html#ga4fb918498d8adc676f4ea554585609d2">XMbox_SetSendThreshold()</a>, <a class="el" href="group__mbox.html#ga254c4e5a042e34520c3669fbf9651bc2">XMbox_Write()</a>, and <a class="el" href="group__mbox.html#ga23ee00f97807790770f2dab9b2ea3b0e">XMbox_WriteBlocking()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
